home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 3 / Amiga Tools 3.iso / terminal / xprz / xprz35.readme < prev    next >
Encoding:
Text File  |  1995-04-18  |  6.6 KB  |  139 lines
  1. Short: xprzmodem and xprzedzap, locale aware, WB2+
  2. Type: comm/term
  3. Uploader: robert_williamson@p0.f104.n167.z1.fidonet.org (Robert Williamson)
  4. Author: robert_williamson@p0.f104.n167.z1.fidonet.org (Robert Williamson)
  5.  
  6.     xprzmodem.library v3.5 for term programs and bbs's
  7.   & xprzedzap.library v3.5 for mailers
  8.  
  9.     xprZ35.lha   contains  AmigaGuide  and  plain  text  docs  as  well  as
  10. 68000/10/20/30/40 versions of both xprzmodem.library and xprzedzap.library.
  11. These  libraries  all require WB2 or better and support language catalogues
  12. via  locale.library.   This  release  merges  the  source levels of the two
  13. libraries so that both can take advantage of all fixes and enhancements.
  14.  
  15.    XPRzedzap.library is an enhanced version of xprzmodem.library for use in
  16. Mailers as well as BBSs and Terminal programs supporting XPR protocols.  It
  17. provides multiple zmodem-derived protocols, including:
  18.     Zmodem, SZmodem, ZedZip, ZedZap and DirectZap.  
  19.   It  is  a complete replacement for xprzmodem.library, xprszmodem.library,
  20. xprdzap.library and all previous versions of xprzedzap.library.
  21.  
  22.     XPRzmodem.library  is  also  enhanced  to provide the same protocols as
  23. xprzedzap.library,  well  as  support  for SZmodem.  It is about 1K smaller
  24. since  it  does  not  include  some of the special features required in FTN
  25. operations.  This version should be used only on systems that do not have a
  26. mailer or where the mailer does not support XPR protocols.
  27.  
  28.  
  29.   Installation problems:
  30.  
  31.   locale.library MUST be installed, as well as the directories that library
  32. expects.
  33.  
  34.   It  has  been  noted  that  some Term programs and BBS's have a hardcoded
  35. setup  for  xprzmodem.library.   In some cases the space reserved is to too
  36. small for the additional options in these libraries and the host may crash.
  37. If  these  programs  have  an external xpr setup options, use that instead.
  38. This method has been reported as solving the problem with Ncomm.
  39.  
  40.   Some  term  programs and BBS's are not coded to the spec, but rather take
  41. short-cuts  which  may  cause  that  program  to  hang when used with these
  42. libraries.  In particular:
  43.   Setting  YY causes XPR2.001 return codes to be set.  These codes make use
  44. of  all  32  bits  in  the  bitmap;  if  the host program only looks at the
  45. low-order  16  bits  or  expects hardcoded values, it will fail.  Never use
  46. this  option in a host that does not support it.  The only known hosts that
  47. do support this option are DreamTerm and wpl.library.
  48.  
  49.     Fixes and Enhancements:
  50.  
  51.     o  REQUIRES wb2+
  52.     o  Locale support.
  53.     o  Defaults optimized for each library to permit MUCH shorter setup
  54.        strings.
  55.     o  XPR 2.001 support for dual-status windows.  
  56.        Protocol now informs host that it supports XPR 2.001 extensions
  57.        and double-buffering. Setup toggles this support and is by default
  58.        disabled for xprzmodem.library and enabled for xprzedzap.library.
  59.     o  XPR 3 callbacks register protection is installed
  60.     o  XPR 3 xpr_updstatus function is enabled, permitting notification
  61.        of transfer status for EACH file sent or received.
  62.     o  Protocol name displayed will be one of: 
  63.         Zmodem, 1K blocks standard
  64.         SZmodem, up to 8K blocks
  65.         ZedZap, up to 8K Blocks size based upon bps rate, ftn mode
  66.         ZedZip, 1k blocks, ftn mode
  67.         DirectZap, up to 8k blocks, minimum escaping, ftn mode
  68.     o  Added status messages for resume
  69.     o  A number of strings were not localized, corrected.  Also added
  70.        localization for new options.  These are NOT translated for
  71.        german catalog, so that catalog has been removed from distribution.
  72.        Catalogues   and   documentation   for  other  languages  should  be
  73.        distributed separately.
  74.    o  During batch transfers, Error message field is set to "None" when
  75.       starting to send or receive next file.
  76.  
  77.    o  New options:
  78.  
  79.       Y XPR2001 Mode    
  80.         Y - When enabled, calls to XprSetup() will return a mask with
  81.             the  additional  bits defined in the XPR 2.001 spec related
  82.             to  double-buffering,  etc.   xpr_update()  calls  will  be
  83.             masked  with  a  bit  indicating  directionof  transfer  to
  84.             support   host   program   rthat  use  dual-staus  windows.
  85.  
  86.         N - XPR2001 support diabled, required for Ncomm, Excelsior
  87.             BBS and other hosts which do not properly handle xpr
  88.             function and callback return codes.
  89.  
  90.  
  91.       Z Enable FTN mode
  92.     The Z option enables FTN operation, when Y, the following is in effect:
  93.         - RxTimeOut is restored to 600ms
  94.         - transfers start with blocksize specified in M option.
  95.         - block size baud-rate dependant
  96.         - serialbuffer is cleared before sending/receiving.  In FTN
  97.           mode the turnaround from sending to receiving (and vis-versa)
  98.           is quite fast, clearing the buffer avoids reading echos of our
  99.           own characters or leftovers from the previous transfer.
  100.  
  101.       M<block size>
  102.         The  maximum  packet  size can now be set with a maximum/default at
  103.     8192.   This  will vary when sending and will be static when receiving.
  104.     When  sending  in  FTN  mode, the maximum packet size will be baud rate
  105.     dependant,  and  the  size  is calculated with the formula MAX_PACKET =
  106.     (BPS_RATE  *  8192 / 9600).  BPS_RATE will be the link rate if set with
  107.     the C option.  You can specify a limit for the maximum packet size with
  108.     the  M  option,  but it only influence the packet size if it is smaller
  109.     than  8K  or  if  one  is  receiving a file.  When not in FTN mode, the
  110.     blocks size is NOT dependant upon the bps rate.
  111.  
  112.       C<link bps>
  113.         All  Buffer  allocations,  and  cps calculations will be based upon
  114.     link  rate  if passed with C<baud> option, otherwise they will be based
  115.     upon  LOCKED  bps.   When  the link rat eis used, the DataRate field of
  116.     status display will show the true CPS of each block.
  117.  
  118.       N   Send no files mode (DirectZap,  ZedZip  and  ZedZap protocols)
  119.         It  is  permitted  to  have  a session without sending or receiving
  120.     files  if  N  option is Y.  This is required with some protocols in FTN
  121.     mode  so  as not to generate a spurious failure after a mailer session.
  122.     This also changes EOF mode from sending CAN's to just sending ZFIN.
  123.         
  124.     Q  Enable DirectZap mode
  125.         Only  ZDLE  adn  ZDLEE  will be escaped if Q option is Y.
  126.  
  127.     ToDO:   
  128.     Add  support  for  TrapZap  if  someone  tells  me what the diff isfrom
  129.     DirectZap :).
  130.   
  131.     Add  support  for returning received file's creation date and option to
  132.     set received file to either reception date or creation date.
  133.  
  134.     MAGIC NAME: XPRZ3
  135.     Robert Williamson
  136.         FidoNet#1:167/104.0
  137.         AmigaNet#40:600/104.0
  138.  
  139.